IStreamAttributes Class Reference
[VST 3 Interfaces to be implemented by Host]

Meta attributes of a stream. More...

#include <ivstattributes.h>

Inheritance diagram for IStreamAttributes:
Inheritance graph
[legend]

Public Member Functions

virtual tresult getFileName (String128 name)=0
 Gets filename (without file extension) of the stream.
virtual IAttributeListgetAttributes ()=0
 Gets meta information list.

Static Public Attributes

static const FUID iid

Detailed Description

Meta attributes of a stream.

...
#include "pluginterfaces/base/ustring.h"
#include "pluginterfaces/vst/vstpresetkeys.h"
...

tresult PLUGIN_API MyPlugin::setState (IBStream* state)
{
   FUnknownPtr<IStreamAttributes> stream (state);
   if (stream)
   {
      IAttributeList* list = stream->getAttributes ();
      if (list)
      {
         // get the current type (project/Default..) of this state
         String128 string;
         if (list->getString (PresetAttributes::kStateType, string, 128 * sizeof (TChar)) == kResultTrue)
         {
            UString128 tmp (string);
            char ascii[128];
            tmp.toAscii (ascii, 128);
            if (!strncmp (ascii, StateType::kProject, strlen (StateType::kProject)))
            {
               // we are in project loading context...
            }
         }

         // get the full file path of this state
         TChar fullPath[1024];
         if (list->getString (PresetAttributes::kFilePathStringType, fullPath, 1024 * sizeof (TChar)) == kResultTrue)
         {
            // here we have the full path ...
         }
      }
   }

   //...read the state here.....
   return kResultTrue;
}

Interface to access preset meta information from stream, used for example in setState in order to inform the plug-in about the current context in which this preset loading occurs (Project context or Preset load (see StateType)) or used to get the full file path of the loaded preset (if available).


Member Function Documentation

virtual tresult getFileName ( String128  name  )  [pure virtual]

Gets filename (without file extension) of the stream.

virtual IAttributeList* getAttributes (  )  [pure virtual]

Gets meta information list.


Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.